Skip to content

[skip changelog] Document floating point ABI configuration folders for precompiled libraries #833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2020
Merged

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 16, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Docs update.

  • What is the current behavior?

Arduino CLI supports the use of a specific folder structure to provide precompiled library binaries for different ARM floating point ABI configurations, but this feature is not documented.

  • What is the new behavior?

The ARM floating point ABI folders for precompiled Arduino libraries feature is documented in the Arduino library specification.

The documentation was restructured a bit by creating a new section for information about the precompiled library folder structure so that this feature could be fully documented without harming the readability of the section that documents the library.properties fields.

  • Does this PR introduce a breaking change?

No.

  • Other information:

Relevant PRs:


See how to contribute

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 16, 2020
per1234 added 2 commits July 23, 2020 02:30
…tion of library specification

As more documentation is added about precompiled libraries, it becomes increasingly awkward to fit in in the bullet list format of the library.properties fields section of the library specification. The specification has a dedicated "Layout of folders and files" section, which is an appropriate place to move the documentation of the precompiled binary files used with this feature. This allows the documentation of the `precompiled` library.properties field to be only about the use of that field, with a link to the section which contains the documentation about the files.
@silvanocerza silvanocerza merged commit e6f8274 into arduino:master Jul 23, 2020
@per1234 per1234 deleted the precompiled-fp-abi branch July 23, 2020 12:42
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants